Skip to content
This repository has been archived by the owner on Oct 4, 2024. It is now read-only.

feat: Add detailed instructions for installing near-cli #1099

Merged
merged 2 commits into from
Feb 29, 2024
Merged

feat: Add detailed instructions for installing near-cli #1099

merged 2 commits into from
Feb 29, 2024

Conversation

jancionear
Copy link
Contributor

The installation guide in README.md provides a brief explanation of how to install the tool, but it isn't as detailed as it could be. For someone who isn't familiar with the javascript ecosystem the whole thing is pretty confusing - why nvm? Can I just do apt install npm? Why not? It took me some time before I found a sequence of instructions that worked.
And users also run into problems

It would be great to have a detailed step-by-step instruction on how to install near-cli. So this PR adds the exact list of steps needed to install near-cli on Ubuntu 20.04 LTS.

@jancionear
Add detaied instructions for installing near-cli
9007f62 
The installation guide in `README.md` provides a brief
explanation of how to install the tool, but it isn't
as detailed as it could be. For someone who isn't familiar
with the javascript ecosystem the whole thing is pretty
confusing - why `nvm`? Can I just do `apt install npm`?
Why not? It took me some time before I found a sequence of
instructions that worked.
[And users also run into problems](https://near.zulipchat.com/#narrow/stream/422293-pagoda.2Fcore.2Fstake-wars-iv/topic/questions.20and.20feedback/near/421267934)

It would be great to have a detailed step-by-step instruction
on how to install `near-cli`. So this PR adds the exact list
of steps needed to install `near-cli` on Ubuntu 20.04 LTS.
@jancionear jancionear changed the title Add detailed instructions for installing near-cli feat: Add detailed instructions for installing near-cli Feb 26, 2024
@gagdiez
Copy link
Contributor

gagdiez commented Feb 26, 2024

hi @jancionear , thanks for the suggestion!

Do you think it is better to explain how to use nvm to install node or how to install node by downloading the binaries and use them? The first option is easier, the second is more universal across distros

@jancionear
Copy link
Contributor Author

jancionear commented Feb 26, 2024 •
edited
Loading

hi @jancionear , thanks for the suggestion!

Do you think it is better to explain how to use nvm to install node or how to install node by downloading the binaries and use them? The first option is easier, the second is more universal across distros

As a linux developer I like the nvm route more - it's a one liner that I can just paste into bash. The binary route seems more complex, I'd have to download the binaries, extract them somewhere, probably add to path...

Ideally it would be great to be able to install the tool with a single line - npm install near-cli and done. Most python tools can be installed with a single pip install, but I don't know if that's possible with javascript. Maybe a flatpak package? x.x

But as long as I can just paste some commands into the terminal without thinking too much and get the tool working reliably, I'm happy.

@jancionear
Copy link
Contributor Author

Another user just installed near-cli incorrectly: https://t.me/near_stake_wars/976

Could we merge those detailed instructions?

@gagdiez gagdiez merged commit ee98774 into near:master Feb 29, 2024
7 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@gagdiez gagdiez gagdiez approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jancionear @gagdiez